home *** CD-ROM | disk | FTP | other *** search
/ Games of Daze / Infomagic - Games of Daze (Summer 1995) (Disc 1 of 2).iso / x2ftp / msdos / utils / raysh386 / readme < prev    next >
Text File  |  1992-02-09  |  8KB  |  173 lines
  1. This is version 4.0 of rayshade, a ray tracing program.
  2. Rayshade reads a multi-line ASCII file describing a scene to be rendered
  3. and produces a Utah Raster Toolkit "RLE" format file containing the
  4. ray traced image.
  5.  
  6. Rayshade features:
  7.  
  8.     Eleven primitives (blob, box, cone, cylinder, height field,
  9.     plane, polygon, sphere, torus, flat- and Phong-shaded triangle)
  10.  
  11.     Aggregate objects
  12.  
  13.     Constructive solid geometry
  14.  
  15.     Point, directional, extended, spot, and quadrilateral light sources
  16.  
  17.     Solid procedural texturing, bump mapping, and
  18.         2D "image" texture mapping
  19.  
  20.     Antialiasing through variable-rate "jittered" sampling
  21.  
  22.     Arbitrary linear transformations on objects and texture/bump maps.
  23.  
  24.     Use of uniform spatial subdivision or hierarchy of bounding
  25.         volumes to speed rendering
  26.  
  27.     Options to facilitate rendering of stereo pairs
  28.  
  29.     Rudimentary animation support
  30.  
  31.  
  32. There are many differences between rayshade versions 3.0 and 4.0.  In
  33. particular, the input syntax has changed.  Input files created for
  34. version 3.0 must be converted to version 4.0 syntax using the provided
  35. conversion utility, rsconvert.  See Doc/Changes for a list of some of
  36. the more important changes.
  37.  
  38. Rayshade v4.0 has been tested on many different UNIX-based computers,
  39. including: SGI 4D, IBM RS6000, Sun Sparcstation 1, Sun 3, DECstation,
  40. Apollo DN10000, NeXT.  If your machine has a C compiler, enough memory
  41. (at least 2Mb), and runs something resembling UNIX, rayshade should be fairly
  42. easy to port.  Be warned that rayshade uses yacc and lex to process input
  43. files.  If you do not have lex and yacc, try to get flex and bison from
  44. the Free Software Foundation folks (ftp to prep.ai.mit.edu).  Attempts
  45. to port rayshade to 16-bit machines will likely lead to nothing but
  46. a profound sense of frustration.
  47.  
  48. Rayshade uses a Configure script in order to determine how it should
  49. be compiled.  This means that if you're not runing under UNIX, you'll
  50. probably have to create a config.h and edit the Makefiles by hand.
  51. If you create a config.h file and/or Makefiles for use in an non-UNIX
  52. environment, send them to us and we will make it available for use by
  53. others.  The prototype config.H file may be of some help.
  54.  
  55. Normally, rayshade makes use of the Utah Raster toolkit.  You are
  56. strongly encouraged to get a copy of the toolkit, as it provides a
  57. host of useful tools for image manipulation and a library for reading/writing
  58. the toolkit's "RLE" format image files.  "blurb.urt" is the "blurb" file from
  59. the latest distribution of the toolkit.  Also of interest is the
  60. "fbm" library, available from nl.cs.cmu.edu:/usr/mlm/ftp/fbm.tar.Z, which
  61. provides additional tools for converting Utah Raster format images
  62. to/from other formats.
  63.  
  64. If you do not want to or cannot use the Utah Raster toolkit, rayshade
  65. can be configured to create image files using a generic format
  66. identical to that used by Mark VandeWettering's "mtv" ray tracer.
  67.  
  68. The rayshade distribution consists of two libraries (libray, libshade) and
  69. several applications (rayshade proper, rayview, raypaint) that are
  70. linked against these libraries.  To compile, run the Configure script to
  71. generate config.h and the Makefiles, then run "make depend"
  72. followed by "make".  If the Configuration script fails, or if
  73. it can't determine a way to generate dependencies, you'll probably
  74. have to edit the Makefiles or extract them from the Makefile.SH scripts
  75. by hand.  Don't be overly alarmed if there are a few non-fatal error
  76. messages while running "make depend"
  77.  
  78. The Doc directory contains a User's Guide in the Guide subdirectory,
  79. as well as a quick-reference sheet and some information that might
  80. be useful in porting or modifying rayshade.  To create a formatted
  81. version of the User's Guide, you'll need LaTeX.  If you don't have
  82. LaTeX, a postscript version of the Guide is available via anonymous
  83. ftp from weedeater.math.yale.edu (see below).
  84.  
  85. The etc directory contains miscellaneous goodies, including the source
  86. to a filter to convert rayshade v3.0 input to rayshade 4.0.
  87. The Example directory contains example input files, which may be
  88. used to test rayshade and to familiarize yourself with rayshade's input
  89. syntax.  You can also run any one of Eric Haines'
  90. Standard Procedural Databases through awk using the etc/nff2shade.awk
  91. script, and then feed the results to rayshade.  Note that for several
  92. of the databases, you will need to tweak the data a bit to achieve
  93. optimal runtimes.  See nff2shade.awk for details.
  94.  
  95. Rayshade was not designed to be, nor is it, the be-all and end-all of
  96. ray tracers.  It was meant to be reasonably fast, portable, and easy to
  97. modify.  It has some nice features which allow you to produce
  98. pretty pictures, but there are countless extensions, modifications,
  99. and improvements which could be made.  There are many routines which may be
  100. optimized and many features which could be added.  For a list of suggested
  101. improvements and projects see "TODO".  You are strongly encouraged to modify
  102. the source code left and right.
  103.  
  104. While there is currently no documentation for the libraries, it
  105. should be easy for you to add your own primitives, textures, aggregates,
  106. and light sources by looking at the code and sending mail if you get
  107. stuck.
  108.  
  109. Additional rayshade goodies are available via anonymous ftp from
  110. weedeater.math.yale.edu (130.132.23.17) in pub/rayshade.4.0.
  111. If you have contributions of new objects, textures, input files,
  112. configuration files, or images to make, feel free to send us email or
  113. to drop off a copy via ftp in the "incoming" directory on weedeater.
  114.  
  115. The first version of rayshade was written by Craig Kolb, David P. Dobkin,
  116. and David C. Hoffman during 1987-1988, and was heavily based on an
  117. "introductory" public domain ray tracer written by Roman Kuchkuda.
  118. Rayshade v3.0 was written by Craig Kolb and released in the Fall of 1989.
  119. Rayshade v4.0 was written by Craig Kolb and Rod Bogart during 1990-1991.
  120.  
  121. Rayshade was made possible by many people who have made suggestions,
  122. fixed bugs, and who have been all-around good sports about the whole thing.
  123.  
  124. Thanks to Gavin Bell, David Dobkin, Eric Haines, Lefteris Koutsofios,
  125. Ken Musgrave, Przemek Prusinkiewicz, and Allan Snider for their
  126. encouragement, comments, and willingness to be on the Front Lines.
  127.  
  128. Thanks to Roman Kuchkuda for providing such a solid base upon which
  129. to build.
  130.  
  131. Special thanks to Robert Skinner for providing the Noise(), DNoise(),
  132. and other texturing functions and allowing them to be redistributed.
  133.  
  134. Pat Hanrahan's OOGL provided the spirit (if not the letter) of the
  135. modularity of rayshade v4.0.  Thanks to Pat and to Mark VandeWettering
  136. for the 'net tracer' conversations and for the inspiration to do something
  137. to clean up rayshade.
  138.  
  139. Thanks to Marc Andreessen, Tony Apodaca, Ray Bellis, Dominique Boisvert,
  140. William Bouma, Allen Braunsdorf, Jeff Butterworth, Nick Carriero,
  141. Nancy Everson, Tom Friedel, Robert Funchess, David Gelernter, Mike Gigante,
  142. Ed Herderick, John Knuston, Raphael Manfredi, Lee Moore, Dietmar Saupe,
  143. Iain Sinclair, Brian Wyvill, and everybody else for their bugfixes,
  144. suggestions, input files, encouragement, and other feedback.
  145.  
  146. Thanks also to Mark Podlipec for providing the blob and torus objects.
  147.  
  148. Thanks to Jochen Schwarze for the cubic and quartic root-finding functions.
  149. His code, and a host of other useful routines, can be found in
  150. "Graphics Gems", edited by Andrew Glassner.
  151.  
  152. Thanks to Benoit Mandelbrot for the support he provided this project.
  153.  
  154. If you find any bugs, make any useful extensions, have a nice input file,
  155. port rayshade to a new environment, or need assistance understanding a
  156. particularly braindamaged section of code, please let us know.  We can be
  157. most easily reached by email.
  158.  
  159. Once you start using rayshade, and you'd like to be kept abreast of
  160. changes and extensions, send a message to rayshade-request@cs.princeton.edu,
  161. and we'll add you to the rayshade mailing list.
  162.  
  163. Craig Kolb
  164. Rod Bogart
  165. 10 January 1992
  166. rayshade-request@cs.yale.edu
  167.  
  168. Craig Kolb 
  169. Computer Science Department
  170. Princeton University
  171. 35 Olden St.
  172. Princeton, NJ 08544
  173.